/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.document2;

import java.util.Iterator;
import java.util.ListIterator;

import kameleon.exception.InvalidIndexException;

/**
 * Represents an array in a text document.
 * 
 * <p>An array is described a an number of cells grouped by row.
 * 
 * <p>Standard properties include : none.
 * 
 * @author		Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * @version		1.0
 * 
 * @see			Rows
 * @see			Row
 * @see			Cell
 */
public class Array extends DocumentElementContainer {

	/**
	 * Needed to serialize this class.
	 * 
	 * @see		java.io.Serializable
	 */
	private static final long serialVersionUID = 6375085272148417618L ;

	/**
	 * Builds an empty array.
	 */
	public Array() {
		super() ;
	}// Array()

	/**
	 * Add an instance of {@code Row} at the specified index.
	 * 
	 * @param 	r
	 * 			instance of {@code Row} added
	 * 
	 * @param 	index
	 * 			insert position
	 * 
	 * @throws	InvalidIndexException
	 * 			if the given index is out of range
	 * 			{@code index < 0 || index >= getCount()}
	 * 
	 * @see		Rows#add(Row, int)
	 */
	public void add(Row r, int index) throws InvalidIndexException {
		
	}// add(Row, int)

	/**
	 * Removes all the instances matching the given {@code Row}.
	 * 
	 * <p>The matching {@code Row} are found using the {@code equals} function.
	 * 
	 * @param 	r
	 * 			removed {@code Row}
	 * 
	 * @see		Rows#remove(Row)
	 */
	public void remove(Row r) {
		
	}// remove(Paragraph)

}// class Array